API Keys¶

API Key¶

API Key is an unique token which uses for Partner authentication. This key should be specified as value for Authorization on each request that been made to TicketsCloud API.

GET /v1/resources/partners/{idpartner}/api_keys/{idkey}¶

Returns an information about API key.

Request Headers:
	Accept – application/json Authorization – API key
Parameters:	idpartner (string) – Partner ID idkey (string) – API Key ID
Query Parameters:
	fields-schema (string) – Fields Schema DSL
Response Headers:
	Content-Type – application/json Transfer-Encoding – `chunked`
Response JSON Object:
	created_at (datetime) – API key creation timestamp id (string) – API Key ID key (string) – API key itself name (string) – API key name partner (string) – Related Partner ID removed (boolean) – Removed flag
Status Codes:	200 OK – Ok 400 Bad Request – Invalid request parameters 401 Unauthorized – Authentication required 403 Forbidden – Operation not allowed

Request:

GET /v1/resources/partners/535fb19bdca6a9d1638f2007/api_keys/53f1d89437abbd0a9ca87882 HTTP/1.1
Accept: application/json
Authorization: key my-very-secret-key
Host: ticketscloud.org

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

{
    "created_at": "2014-08-18T10:42:28.288000+00:00",
    "id": "53f1d89437abbd0a9ca87882",
    "key": "48de25a3c7f84996bc3c183c640f9948",
    "name": "new-key",
    "partner": "535fb19bdca6a9d1638f2007",
    "removed": false
}

PATCH /v1/resources/partners/{idpartner}/api_keys/{idkey}¶

Updates API key information.

Request Headers:
	Accept – application/json Authorization – API key
Parameters:	idpartner (string) – Partner ID idkey (string) – API Key ID
Query Parameters:
	fields-schema (string) – Fields Schema DSL
Request JSON Object:
	name (string) – API key name
Response Headers:
	Content-Type – application/json Transfer-Encoding – `chunked`
Response JSON Object:
	created_at (datetime) – API key creation timestamp id (string) – API Key ID key (string) – API key itself name (string) – API key name partner (string) – Related Partner ID removed (boolean) – Removed flag
Status Codes:	200 OK – Ok 400 Bad Request – Invalid request parameters 401 Unauthorized – Authentication required 403 Forbidden – Operation not allowed

Request:

PATCH /v1/resources/partners/535fb19bdca6a9d1638f2007/api_keys/53f1d89437abbd0a9ca87882 HTTP/1.1
Accept: application/json
Authorization: key my-very-secret-key
Content-Length: 21
Content-Type: application/json; charset=utf-8
Host: ticketscloud.org

{
    "name": "new-name"
}

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

{
    "created_at": "2014-08-18T10:42:28.288000+00:00",
    "id": "53f1d89437abbd0a9ca87882",
    "key": "48de25a3c7f84996bc3c183c640f9948",
    "name": "new-name",
    "partner": "535fb19bdca6a9d1638f2007",
    "removed": false
}

DELETE /v1/resources/partners/{idparner}/api_keys/{idkey}¶

Removes an API key.

Request Headers:
	Accept – application/json Authorization – API key
Parameters:	idpartner (string) – Partner ID idkey (string) – API Key ID
Response Headers:
	Content-Type – application/json Transfer-Encoding – `chunked`
Status Codes:	200 OK – Ok 400 Bad Request – Invalid request parameters 401 Unauthorized – Authentication required 403 Forbidden – Operation not allowed

Request:

DELETE /v1/resources/partners/535fb19bdca6a9d1638f2007/api_keys/53f1d89437abbd0a9ca87882 HTTP/1.1
Accept: application/json
Authorization: key my-very-secret-key
Host: ticketscloud.org

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

{}

API Keys¶

Manages API Key collection of specific Partner.

GET /v1/resources/partners/{idpartner}/api_keys¶

Returns list of API keys which Partner has.

Request Headers:
	Accept – application/json Authorization – API key
Parameters:	idpartner (string) – Partner ID
Query Parameters:
	ids (string) – List of IDs to return fields-schema (string) – Fields Schema DSL
Response Headers:
	Content-Type – application/json Transfer-Encoding – `chunked`
Response JSON Array of Objects:
	created_at (datetime) – API key creation timestamp id (string) – API Key ID key (string) – API key itself name (string) – API key name partner (string) – Related Partner ID removed (boolean) – Removed flag
Status Codes:	200 OK – Ok 400 Bad Request – Invalid request parameters 401 Unauthorized – Authentication required 403 Forbidden – Operation not allowed

Request:

GET /v1/resources/partners/535fb19bdca6a9d1638f2007/api_keys HTTP/1.1
Accept: application/json
Authorization: key my-very-secret-key
Host: ticketscloud.org

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

[
    {
        "created_at": "2014-08-18T10:30:02.516000+00:00",
        "id": "53f1d5aa37abbd0a9da87882",
        "key": "my-very-secret-key",
        "name": "test",
        "partner": "535fb19bdca6a9d1638f2007",
        "removed": false
    },
    {
        "created_at": "2014-08-18T10:30:23.487000+00:00",
        "id": "53f1d5bf37abbd0a9ea87882",
        "key": "5a1428de2cd84b5189453470dffa3b5d",
        "name": "default",
        "partner": "535fb19bdca6a9d1638f2007",
        "removed": false
    },
    {
        "created_at": "2014-08-18T10:31:01.930000+00:00",
        "id": "53f1d5e537abbd0a9da87883",
        "key": "aaef4478264a4be2b2c9838efa8df7c6",
        "name": "crm",
        "partner": "535fb19bdca6a9d1638f2007",
        "removed": false
    }
]

POST /v1/resources/partners/{idpartner}/api_keys¶

Creates a new API Key.

Request Headers:
	Accept – application/json Authorization – API key
Parameters:	idpartner (string) – Partner ID
Query Parameters:
	fields-schema (string) – Fields Schema DSL
Request JSON Object:
	name (string) – API key name
Response Headers:
	Content-Type – application/json Transfer-Encoding – `chunked`
Response JSON Object:
	created_at (datetime) – API key creation timestamp id (string) – API Key ID key (string) – API key itself name (string) – API key name partner (string) – Related Partner ID removed (boolean) – Removed flag
Status Codes:	201 Created – Created 400 Bad Request – Invalid request parameters 401 Unauthorized – Authentication required 403 Forbidden – Operation not allowed

Request:

POST /v1/resources/partners/535fb19bdca6a9d1638f2007/api_keys HTTP/1.1
Accept: application/json
Authorization: key my-very-secret-key
Content-Length: 20
Content-Type: application/json; charset=utf-8
Host: ticketscloud.org

{
    "name": "new-key"
}

Response:

HTTP/1.1 201 Created
Content-Length: 203
Content-Type: application/json; charset=UTF-8

{
    "created_at": "2014-08-18T10:42:28.288420+00:00",
    "id": "53f1d89437abbd0a9ca87882",
    "key": "48de25a3c7f84996bc3c183c640f9948",
    "name": "new-key",
    "partner": "535fb19bdca6a9d1638f2007",
    "removed": false
}

API Keys¶

API Key¶

API Keys¶

Оглавление

Предыдущий раздел

Следующий раздел

Эта страница

Навигация

API Keys¶

API Key¶

API Keys¶

Оглавление

Предыдущий раздел

Следующий раздел

Эта страница

Быстрый поиск

Навигация