Greer Whitley - 04/06/2024

Telegraph is a publishing platform that allows you to create simple web pages using their API. In this article, we'll explore some of the key endpoints of the Telegraph API and see how to interact with them.

Authentication

To use the Telegraph API, you need an access token. The access token is included as a query parameter in the API requests. In the examples below, replace your_access_token with your actual access token.

Get Page List

To retrieve a list of pages associated with your account, you can use the getPageList endpoint. Here's an example request:

https://api.telegra.ph/getPageList?access_token=your_access_token&limit=3

The limit parameter specifies the maximum number of pages to return. In this example, we're requesting up to 3 pages.

Get Account Info

To retrieve information about your Telegraph account, you can use the getAccountInfo endpoint. Here's an example request:

https://api.telegra.ph/getAccountInfo?access_token=your_access_token&fields=["short_name","page_count"]

The fields parameter allows you to specify the specific fields you want to retrieve. In this example, we're requesting the short_name and page_count fields.

Create a Page

To create a new page on Telegraph, you can use the createPage endpoint. Here's an example request:

https://api.telegra.ph/createPage?access_token=your_access_token&title=Sample+Page&author_name=Anonymous&content=[{"tag":"p","children":["Hello,+world!"]}]&return_content=true

The title parameter sets the title of the page, author_name specifies the author name, and content is an array of content nodes representing the page's content. In this example, we're creating a simple page with a single paragraph saying "Hello, world!".

The return_content parameter, when set to true, indicates that the API should return the content of the newly created page in the response.

Conclusion

The Telegraph API provides a simple way to create and manage web pages programmatically. By using the getPageList, getAccountInfo, and createPage endpoints, you can retrieve information about your account, list existing pages, and create new pages with custom content.

To get started, obtain an access token and start exploring the Telegraph API endpoints. Happy coding!