Getting started

Guide to getting started with uCoz API

New authorization method via Bearer Token (recommended)

All requests to the API require authorization via the Bearer token. To obtain an access token, you need to create a key on your uCoz website in the control panel according to instructions.

Test requests directly in the documentation. The new authorization method supports the “Try it” function in module documentation. Specify your domain in the Server field and enter the Bearer token in the Authorize field.

Activation of modules for uAPI

Important: to activate the uCoz module for uAPI, go to the Control Panel of your site (yoursite/admin), then in the top menu open the Site → uAPI section and enable the API for the required modules.

Old OAuth 1.0a authorization method (deprecated)

The application is created on the uAPI registration page.

After creating the application, you must obtain a Consumer key, Consumer secret, OAuth token and OAuth token secret to work with uAPI. To do this, you need to run three queries:

Step 1. Obtaining a temporary token

POST to http://uapi.ucoz.com/accounts/OAuthGetRequestToken

Parameters:

In response you will receive temporary oauth_token and oauth_token_secret.

Step 2. Application authorization

GET to http://uapi.ucoz.com/accounts/OAuthAuthorizeToken

Parameters: oauth_token, oauth_token_secret.

At this step, the rights to use your data in the application are confirmed. In response you will receive temporary oauth_token and oauth_verifier.

Step 3. Obtaining working keys

POST to http://uapi.ucoz.com/accounts/OAuthGetAccessToken

Parameters:

This is the last step - here you will get the final (working) Consumer key, Consumer secret, OAuth token and OAuth token secret. All received data will be saved in your profile on the page uAPI panel.

OAuth Playground - interactive sandbox will help you test connecting to the API using the old authorization method.