SAPITI.net

https://sapiti.ovh/v1
Admin
SAPITI.net is an API service that enables developers to access information from multiple modern...
Tokens:3,059
Snippets:20
Trust Score:4.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### PHP Library Installation

Source: https://sapiti.ovh/v1/index

Instructions on how to install the Sapiti API client library for PHP using Composer.

```APIDOC
## PHP Library

### Description
Instructions for installing the official Sapiti API client library for PHP, enabling easier integration with your PHP projects.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
N/A

### Installation using Composer
To add the Sapiti API library to your project, run the following command in your terminal:

```bash
composer require mediamorphosebe/sapiti-client
```

### GitHub Repository
The PHP library is available on Github: https://github.com/mediamorphose/SapitiClient
```

--------------------------------

### Install Sapiti API Client - Composer

Source: https://sapiti.ovh/v1/index

This command uses Composer, a dependency manager for PHP, to install the Sapiti API client library into your project. This allows for easier integration with the Sapiti API.

```bash
composer require mediamorphosebe/sapiti-client
```

--------------------------------

### API Request Identification

Source: https://sapiti.ovh/v1/index

Details on how to authenticate and identify your application when making requests to the Sapiti API.

```APIDOC
## API Authentication

### Description
All requests to the Sapiti API must include identification parameters such as a public key, timestamp, and signature for authentication.

### Method
All (POST, GET, etc.)

### Endpoint
All API endpoints

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **publickey** (string) - Required - Your application's public key.
- **timestamp** (string) - Required - The current timestamp in ISO 8601 format. Must be within 30 seconds of the server's clock.
- **signature** (string) - Required - A signature generated using your private key, public key, and timestamp.
- **language** (string) - Optional - The desired language for the response (e.g., 'fr').

### Request Example
```json
{
    "publickey": "27A77FC5-4118-B3F9-ABF9-E1F82932ED6B",
    "timestamp": "2020-03-03T15:46:46+01:00",
    "signature": "e276b48bc7d899ff17a4e899e71ad16f7e84ec0bd608a6bb5c75c6bab878db9",
    "language": "fr"
}
```

### Signature Generation (PHP Example)
```php
<?php
$timeStamp = date('c');
$stringToEncore = $publicKey . $timeStamp;
$signature = hash_hmac("sha256", $stringToEncore, $privateKey);
?>
```

### Response
#### Success Response (200)
Standard API response structure.

#### Response Example
```json
{
    "success": true,
    "response": {},
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T10:18:58+01:00",
    "cached": false,
    "status_code": 200,
    "language": "fr"
}
```
```

--------------------------------

### Generate Signature - PHP

Source: https://sapiti.ovh/v1/index

This PHP code snippet demonstrates how to generate the API signature required for authentication. It concatenates the public key and timestamp, then uses HMAC-SHA256 with the private key to create the signature.

```php
$timeStamp= date('c');
$stringToEncore=$publicKey.$timeStamp;
$signature = hash_hmac("sha256", $stringToEncore, $privateKey);
```

--------------------------------

### Server Availability Check

Source: https://sapiti.ovh/v1/index

This endpoint checks the availability of the Sapiti API server by returning a simple 'pong' response.

```APIDOC
## GET /ping/

### Description
Checks the server availability and returns a 'pong' message.

### Method
GET

### Endpoint
/ping/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **response** (object) - Contains the message 'pong'.
- **environment** (string) - The current environment (e.g., 'test').
- **api_version** (integer) - The API version.
- **datetime** (string) - The server's current datetime in ISO 8601 format.
- **cached** (boolean) - Indicates if the response was served from cache.
- **status_code** (integer) - The HTTP status code.
- **language** (string) - The content language.

#### Response Example
```json
{
    "success": true,
    "response": {
        "message": "pong"
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T10:18:58+01:00",
    "cached": false,
    "status_code": 200,
    "language": "fr"
}
```
```

--------------------------------

### General API Response Structure

Source: https://sapiti.ovh/v1/index

Describes the common structure of all responses from the Sapiti API, including success status, response data, and metadata.

```APIDOC
## General Response Structure

### Description
All responses from the Sapiti API follow a consistent structure, providing information about the request's success, the data returned, and environment details.

### Method
All

### Endpoint
All API endpoints

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successfully processed.
- **response** (json formatted / null) - The main content of the response. This will be a JSON object on success or null on error.
- **environment** (string) - Indicates the environment the API is running in ('test' or 'prod').
- **api_version** (integer) - The version of the API being used.
- **datetime** (string) - The server's current date and time in ISO 8601 format.
- **cached** (boolean) - Indicates whether the response was served from a cache.
- **status_code** (integer) - The HTTP status code of the response.
- **language** (string) - The language of the content in the response.

#### Response Example (Success)
```json
{
    "success": true,
    "response": {
        "some_data": "example"
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T10:18:58+01:00",
    "cached": false,
    "status_code": 200,
    "language": "fr"
}
```

#### Response Example (Error)
```json
{
    "success": false,
    "response": null,
    "error": {
        "code": 1501,
        "message": "id not found"
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T11:33:38+01:00",
    "cached": false,
    "status_code": 404
}
```
```

--------------------------------

### Ping Server Availability - JSON Response

Source: https://sapiti.ovh/v1/index

This code snippet demonstrates the expected JSON response when pinging the Sapiti API server to check its availability. It includes fields like success status, response message, environment, API version, datetime, cache status, status code, and language.

```json
{
    "success": true,
    "response": {
        "message": "pong"
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T10:18:58+01:00",
    "cached": false,
    "status_code": 200,
   "language": "fr"
}
```

--------------------------------

### Error Codes

Source: https://sapiti.ovh/v1/index

Lists the specific error codes returned by the Sapiti API in case of failures, along with their descriptions.

```APIDOC
## Error Codes

### Description
This section outlines the specific error codes that may be returned by the Sapiti API when a request fails, providing details on the nature of the error.

### Method
All

### Endpoint
All API endpoints

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Error code** (integer) - The specific error code.
- **Description** (string) - A description of the error.

| Error code | Description |
|---|---|
| 1000 | method not allowed |
| 1020 | invalid json syntax |
| 1050 | A required parameter is missing |
| 1051 | A parameter is invalid |
| 1100 | Authentication required |
| 1101 | Invalid signature |
| 1501 | Provided id not found |
```

--------------------------------

### Status Codes

Source: https://sapiti.ovh/v1/index

Lists the HTTP status codes returned in the response header and their meanings.

```APIDOC
## Status Codes

### Description
This section details the HTTP status codes that can be returned in the response header of Sapiti API requests.

### Method
All

### Endpoint
All API endpoints

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **Code** (integer) - The HTTP status code.
- **Description** (string) - A brief explanation of the status code.

| Code | Description |
|---|---|
| 200 | success |
| 400 | bad request |
| 401 | unauthorized |
| 403 | access denied |
| 404 | resource not found |
| 500 | internal error |
```

--------------------------------

### Standard API Response Structure - JSON

Source: https://sapiti.ovh/v1/index

This JSON structure represents a successful response from the Sapiti API. It includes a 'success' flag, a 'response' object for data, environment details, API version, timestamp, cache status, and HTTP status code.

```json
{
    "success": true,
    "response": {
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T10:18:58+01:00",
    "cached": false,
    "status_code": 200,
    "language": "fr"
}
```

--------------------------------

### Application Authentication Request Body - JSON

Source: https://sapiti.ovh/v1/index

This JSON object represents the mandatory information required in the request body for application-level authentication with the Sapiti API. It includes a public key, timestamp, and signature for request verification.

```json
{
"publickey":"27A77FC5-4118-B3F9-ABF9-E1F82932ED6B",
"timestamp":"2020-03-03T15:46:46+01:00",
"signature":"e276b48bc7d899ff17a4e899e71ad16f7e84ec0bd608a6bb5c75c6bab878db9",
"language": "fr"
}
```

--------------------------------

### API Error Response Structure - JSON

Source: https://sapiti.ovh/v1/index

This JSON structure illustrates an error response from the Sapiti API. It indicates failure with 'success: false' and provides an 'error' object containing a specific error code and message, along with standard API metadata.

```json
{
    "success": false,
    "response": null,
    "error": {
        "code": 1501,
        "message": "id not found"
    },
    "environment": "test",
    "api_version": 1,
    "datetime": "2020-03-04T11:33:38+01:00",
    "cached": false,
    "status_code": 404
}
```
Tokens:
Raw