Create API Key

Create API Key

POST https://api.ocamba.com/v2/ocamba/personal-api-keys
Creates a new API Key objects

Request schema

body

Response schemas

curl -X POST \
 "https://api.ocamba.com/v2/ocamba/personal-api-keys" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My API key",
  "description": "API key used for ...",
  "start_time": "2024-08-08 13:00:00",
  "end_time": "2024-10-09 13:00:00"
}'
const url = 'https://api.ocamba.com/v2/ocamba/personal-api-keys';
const options = {
  method: 'POST',
  headers: {
    Authorization: "Bearer {TOKEN}",
    'Content-Type': "application/json"
  },
  body: JSON.stringify(
    {
      "name": "My API key",
      "description": "API key used for ...",
      "start_time": "2024-08-08 13:00:00",
      "end_time": "2024-10-09 13:00:00"
    }
  )
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v2/ocamba/personal-api-keys");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(
  [
    "name" => "My API key",
    "description" => "API key used for ...",
    "start_time" => "2024-08-08 13:00:00",
    "end_time" => "2024-10-09 13:00:00"
  ]
));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

201 Created

{
  "id": "1002168",
  "company_id": "6197120",
  "name": "My API key",
  "description": "API key used for ...",
  "status": "active",
  "secret": "a2e9a25b9a4f57f3d307bebafb0ac9db3d78f4ce",
  "start_time": "2024-08-08 13:00:00",
  "end_time": "2024-10-09 13:00:00"
  "create_time": "2024-08-09 13:05:50",
  "update_time": "2024-08-09 13:05:50"
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}
Responses