README

You should have jwt-key and api-key keys to be able to use our API via this SDK. jwt-key is a CSR file.

Generating a CSR file

A Certificate Signing Request (.csr) file is required to authenticate an API user and to get your API-Key. The .csr file contains your API public key that will be used to validate the request signature. To generate your RSA 4096 private key (stored in pspakr_secret.key) for signing requests, use the following command line:

openssl req -new -newkey rsa:4096 -nodes -keyout pspakr_secret.key -out pspark_public_key.csr

Make sure you keep the API secret key (pspark_secret.key) safe and secure. Do not share your API secret key with anyone. To get your API-key you should upload your pspark_public_key in the cabinet.pspark.io.

Request examples

Bellow shown a simple example of SDK usage.

<?php

declare(strict_types=1);

namespace App;

use PsPark\PsPark;
use PsPark\Config;

$pspark = new PsPark(new Config(jwtKey: 'jwt-key', apiKey: 'api-key'));
$result = $pspark->getBalance(new BalanceRequest(nonce: time()))->asArray();

More request examples can find here.

You can easily configure SDK by using your framework's DI (service provider e.t.c.) or create your own simple factory.

Validation errors

The API doesn't implement all RESTFull API requirements and has its own response structure.

All HTTP responses from the server will have 200 status code. So, if your request will have some validation errors, the code, and it's description will be presented in the response body as shown bellow.

Response Example

{
  "code": 1002,
  "message": "error description",
  "data": {
    //... some data
  }
}

Each time when the server's response will have some validation errors, the SDK will throw ResponseValidationException exception. All types of validation errors can be find in the API Doc.

pspark / sdk

Maintainers

Details

README

Generating a CSR file

Request examples

Validation errors