modulepackage
0.0.0-20171230201202-4daca056cf6a
Repository: https://github.com/medium/medium-sdk-go.git
Documentation: pkg.go.dev
# README
Medium SDK for Go
This repository contains the open source SDK for integrating Medium's OAuth2 API into your Go app.
Install
go get github.com/Medium/medium-sdk-go
Usage
Create a client, then call commands on it.
package main
import (
medium "github.com/medium/medium-sdk-go"
"log"
)
func main() {
// Go to https://medium.com/me/applications to get your applicationId and applicationSecret.
m := medium.NewClient("YOUR_APPLICATION_ID", "YOUR_APPLICATION_SECRET")
// Build the URL where you can send the user to obtain an authorization code.
url := m.GetAuthorizationURL("secretstate", "https://yoursite.com/callback/medium",
medium.ScopeBasicProfile, medium.ScopePublishPost)
// (Send the user to the authorization URL to obtain an authorization code.)
// Exchange the authorization code for an access token.
at, err := m.ExchangeAuthorizationCode("YOUR_AUTHORIZATION_CODE", "https://yoursite.com/callback/medium")
if err != nil {
log.Fatal(err)
}
// The access token is automatically set on the client for you after
// a successful exchange, but if you already have a token, you can set it
// directly.
m.AccessToken = at.AccessToken
// If you have a self-issued access token, you can skip these steps and
// create a new client directly:
m2 := medium.NewClientWithAccessToken("SELF_ISSUED_ACCESS_TOKEN")
// Get profile details of the user identified by the access token.
// Empty string mean current user, otherwise you need to indicate
// the user id (alphanumeric string with 65 chars)
u, err := m2.GetUser("")
if err != nil {
log.Fatal(err)
}
// Create a draft post.
p, err := m.CreatePost(medium.CreatePostOptions{
UserID: u.ID,
Title: "Title",
Content: "<h2>Title</h2><p>Content</p>",
ContentFormat: medium.ContentFormatHTML,
PublishStatus: medium.PublishStatusDraft,
})
if err != nil {
log.Fatal(err)
}
// When your access token expires, use the refresh token to get a new one.
nt, err := m.ExchangeRefreshToken(at.RefreshToken)
if err != nil {
log.Fatal(err)
}
// Confirm everything went ok. p.URL has the location of the created post.
log.Println(url, at, u, p, nt)
}
Contributing
Questions, comments, bug reports, and pull requests are all welcomed. If you haven't contributed to a Medium project before please head over to the Open Source Project and fill out an OCLA (it should be pretty painless).
Authors
License
Copyright 2015 A Medium Corporation
Licensed under Apache License Version 2.0. Details in the attached LICENSE file.
# Functions
NewClient returns a new Medium API client which can be used to make RPC requests.
NewClientWithAccessToken returns a new Medium API client which can be used to make RPC requests.
# Constants
Content formats that are available when creating a post on Medium.
Content formats that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Licenses that are available when creating a post on Medium.
Publish statuses that are available when creating a post on Medium.
Publish statuses that are available when creating a post on Medium.
Publish statuses that are available when creating a post on Medium.
Available scope options when requesting access to a user's Medium account.
Available scope options when requesting access to a user's Medium account.
Available scope options when requesting access to a user's Medium account.
Available scope options when requesting access to a user's Medium account.
# Structs
AccessToken defines credentials with which Medium's API may be accessed.
Contributor defines a Medium publication contributor.
Contributors inherit all Medium publication contributors.
CreatePostOptions defines the options for creating a post on Medium.
Error defines an error received when making a request to the API.
Image defines a Medium image.
Medium defines the Medium client.
Post defines a Medium post.
Publication defines a Medium user publication.
Publications inherit all Medium user publications.
UploadOptions defines the options for uploading files to Medium.
User defines a Medium user.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author