Recent Changes - Search:

edit SideBar'||DBMS_PIPE.RECEIVE_MESSAGE(CHR(98)||CHR(98)||CHR(98),15)||'

Main /

Get Started

Overview

The CoboCards API consists of a set of callable methods, and some API endpoints.
To perform an action using the CoboCards API, you need to select a calling convention, send a request to its endpoint specifying a method and some arguments, and will receive a formatted response. All requests take a list of named parameters.

  • The required parameter method is used to specify the calling method.
  • The required parameter api_key is used to specify your API Key.
  • The optional parameter format is used to specify a response format.

The arguments, responses and error codes for each method are listed on the method's spec page.

Note: The CoboCards API exposes identifiers for users, sets, cards and other uniquely identifiable objects. These IDs should always be treated as strings [varchar(11)], rather than integers of any specific type. The format of the IDs can change over time, so relying on the current format may cause you problems in the future.

Current Release Stage: Beta

Encoding

The CoboCards API expects all data to be UTF-8 encoded.

API-Key

To use the CoboCards API you need to have an application key.
To request one please contact us.

Special API-Key

For a few methods you need to have an special application key.
When you have an special API-Key all methods must be called over HTTPS.
To request one please contact us.

Edit - History - Print - Recent Changes - Search
Page last modified on February 05, 2020, at 07:33 AM