Key Concepts

Below are some key concepts about the API. It is highly recommended that you understand this page before you start working on other endpoints.

API URL

The URL to make API calls is

https://api.dyntube.com/v1/

API Version

The current API version is 1. So you can replace the version number where needed in the API.

Plan Types

Some of the API endpoints need a field planType or storePanType. Whenever you are required to provide this field, you can use the following endpoint to get the planType.

GET https://api.dyntube.com/v1/account/plans

You can use the value of the field "type" from the JSON response.

200: OK

  [
    {
        "name": "Standard",
        "type": 1,
        "created": "2018-05-09T09:13:51.1283277+00:00"
    },
     {
        "name": "Edge Plan",
        "type": 2,
        "created": "2018-08-15T01:49:43.2197+00:00"
    }
  ]

Region Codes

In a few parts of the API, you are requested to provide region. For example, if you create a project using the API, you will need to provide a region & planType for the project.

Please use the following region codes & plan types depending on your subscribed plan.

Region Codes for Standard Plans

REGION NAME	CODE
US East	use-s
US West	usw-s
US Centeal	usc-s
Canada	can-s
Netherland	euc-s
Germany	deu-s
France	fra-s
United Kingdom	gbr-s
Singapore	sgp-s
Australia	aus-s
Japan	apn-s