Skip to content

zadarma/openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zadarma OpenAPI Specification

OpenAPI 3.0.3 specification for the Zadarma VoIP API.

Quick Start

Validate the specification:

npx @redocly/cli lint spec/v1/openapi.json

Preview rendered documentation locally:

npx @redocly/cli preview spec/v1/openapi.json

Build a standalone HTML documentation file:

npx @redocly/cli build-docs spec/v1/openapi.json -o index.html

Using the Spec

Import spec/v1/openapi.json into tools like:

Authentication

Every request requires an Authorization header in the format userKey:signature. The signature is computed as:

  1. Sort request parameters alphabetically by key
  2. Build a query string (RFC 1738)
  3. Concatenate: method_path + query_string + md5(query_string)
  4. signature = base64(HMAC-SHA1(concatenated_string, secret_key))

Rate limits: 100 requests/min (general), 3 requests/min (statistics endpoints).

Official SDKs

License

MIT

About

OpenAPI specification for the Zadarma API

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors