Початок роботи

Ця сторінка допоможе вам розпочати роботу з публічним API RO App.

Наш API дозволяє програмно взаємодіяти з вашим обліковим записом RO App для керування даними, такими як завдання, клієнти, замовлення, склад та багато іншого. Завдяки безпечному та надійному RESTful-інтерфейсу ви можете інтегрувати RO App у внутрішні системи, автоматизувати бізнес-процеси та створювати функціональні застосунки.

Базова URL-адреса

https://api.roapp.io

Обмеження на кількість запитів (Rate Limits)

Кількість запитів, які може надсилати ваш застосунок, обмежена з метою запобігання зловживанням і забезпечення стабільної роботи.
• Дозволено надсилати до 3 запитів на секунду.
• Якщо ви перевищите це обмеження, API поверне статус-код 429 Too Many Requests.

Пагінація

Пагінація доступна для всіх запитів, які повертають параметр page. Параметр count відображає загальну кількість записів. Кожен запит із пагінацією повертає до 50 записів. Переглядайте дані посторінково, додаючи параметр page=N до запиту.

Автентифікація

Усі запити до Публічного API мають проходити автентифікацію за допомогою Bearer Token.

Додайте ваш API-ключ до заголовка Authorization у кожному запиті у такому форматі:

Authorization: Bearer YOUR_API_KEY

API-ключ прив’язаний до профілю користувача й доступний у вашому обліковому записі RO App в розділі Налаштування > API.

Приклад

Ось приклад того, як отримати список завдань за допомогою API RO App:

HTTP

GET /tasks HTTP/1.1
Host: api.roapp.io
Authorization: Bearer 946389976c464478beb0cf7a7b5b01bb

Python

import requests

API_KEY = "946389976c464478beb0cf7a7b5b01bb"
url = "https://api.roapp.io/tasks"
headers = {
    "Authorization": f"Bearer {API_KEY}"
}

response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())

PHP

<?php
$apiKey = "946389976c464478beb0cf7a7b5b01bb";

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.roapp.io/tasks",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $apiKey"
    ]
]);

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

echo "HTTP Status: $httpCode\n";
echo "Response: $response\n";
?>

Kotlin

import okhttp3.OkHttpClient
import okhttp3.Request

const val API_KEY = "946389976c464478beb0cf7a7b5b01bb"

fun main() {
    val client = OkHttpClient()

    val request = Request.Builder()
        .url("https://api.roapp.io/tasks")
        .addHeader("Authorization", "Bearer $API_KEY")
        .build()

    val response = client.newCall(request).execute()
    println("HTTP Status: ${response.code}")
    println("Response: ${response.body?.string()}")
}

Java

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
    private static final String API_KEY = "946389976c464478beb0cf7a7b5b01bb";

    public static void main(String[] args) throws Exception {
        URL url = new URL("https://api.roapp.io/tasks");
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setRequestMethod("GET");
        conn.setRequestProperty("Authorization", "Bearer " + API_KEY);

        int status = conn.getResponseCode();
        BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
        String inputLine;
        StringBuilder content = new StringBuilder();

        while ((inputLine = in.readLine()) != null) {
            content.append(inputLine);
        }

        in.close();
        conn.disconnect();

        System.out.println("HTTP Status: " + status);
        System.out.println("Response: " + content.toString());
    }
}

Примітки

• Запити без дійсного токена повернуть помилку 401 Unauthorized (Неавторизовано).
• Токени є унікальними для вашого облікового запису та повинні зберігатися в безпеці.
  Не діліться ними публічно.
• Якщо ваш токен було скомпрометовано, ви можете згенерувати новий у розділі Налаштування > API.