cj logo

Authentication

Copied!
copy

The ClearJet API uses API keys to authenticate requests.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made overHTTPS.Calls made over plain HTTP will fail. API requests without authentication will also fail.

Additionally, please note that the access token provided with the API key is valid for a period of 24 hours only. To renew the token, you will need to repeat the API call and obtain a fresh token.

Authorization

This request is using Bearer Token from collection ClearJet API

Body

Bearer Token
json
Copied!
copy
1{
2    "email": "example@email.com",
3    "password": "5z:uV~4L"
4}

Example Request

curl
Copied!
copy
1curl --location 'https://os.clearjet.com/version-test/api/1.1/wf/auth' \
2--data-raw '{
3    "email": "example@email.com",
4    "password": "5z:uV~4L"
5}'

Example Response

json
Copied!
copy
1{
2  "status": "success",
3  "response": {
4    "token": "bus|1709589420293x841280466847544200|1717766441661x199006252111871840",
5    "user_id": "1709589420293x841280466847544200",
6    "expires": 86400
7  }
8}

Date

Mon, 04 Mar 2024 21:58:21 GMT

Content-Type

application/json

Transfer-Encoding

chunked

Connection

keep-alive

x-powered-by

Express

access-control-allow-origin

*

x-bubble-perf

{"total":121.9,"percents":{"top":{"bubble_cpu":23.4,"block":75.3,"capacity_rl":0,"other_pause":0,"pre_fiber":0.5},"sub":{"pp_userdb":6.6,"pp_wait_userdb":0,"http_request":0,"serverjson":56.2,"appserver_cache_misses_time":0,"redis":40.6,"fiber_queue":2.5,"capacity_wait":1.8}},"counts":{"pp_userdb":2,"http_request":0,"derived_build":0,"derived_cache_attempts":3,"derived_cache_memory_misses":3,"serverjson":24,"appserver_cache_attempts":1,"appserver_mem_cache_hits":0,"appserver_cache_hits":1,"appserver_cache_misses":0,"redis":56,"fiber_queue":54,"blocks":53},"misc":{"userdb_results":4,"userdb_data":1212,"spent_time":6274719}}

x-bubble-capacity-used

0.097 unit-seconds used

x-bubble-capacity-limit

0 ms slower

vary

Accept-Encoding

CF-Cache-Status

DYNAMIC

Server

cloudflare

CF-RAY

85f5208c5cff398c-IAD

Content-Encoding

br