API для поставщиков

Получите ключ

Откройте портал поставщика с адреса, с которого котирует ваш деск. Пришедшая ссылка выполнит вход, а ваш ключ будет на этой странице. Ключи начинаются с bfps_ и никогда не истекают; вы можете сменить ключ на той же странице.

Относитесь к нему как к паролю. Любой, кто им владеет, может размещать цены от вашего имени, а неверная цена, приписанная вам, хуже для вас, чем для нас.

Размещение цен

POST https://bunkerfuelprices.com/api/v1/supplier/prices

curl -X POST https://bunkerfuelprices.com/api/v1/supplier/prices \
  -H "Authorization: Bearer bfps_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prices": [
      { "port": "SGSIN", "grade": "VLSFO", "amount": 784.50 },
      { "port": "SGSIN", "grade": "MGO",   "amount": 1146.00 },
      { "port": "AEFJR", "grade": "VLSFO", "amount": 795.00,
        "minMt": 200, "validHours": 24, "basis": "delivered" }
    ]
  }'

Поля

Ответ

{
  "accepted": 3,
  "published": 2,
  "held": 1,
  "results": [
    { "port": "SGSIN", "grade": "VLSFO", "ok": true, "published": true,
      "submissionId": "..." },
    { "port": "SGSIN", "grade": "MGO",   "ok": true, "published": true,
      "submissionId": "..." },
    { "port": "AEFJR", "grade": "VLSFO", "ok": true, "published": false,
      "heldForReview": ["38% away from the $795 median across 6 other ports"] }
  ]
}

Строка, далёкая от рынка в других портах, задерживается для проверки человеком, а не публикуется. Это не сомнение в вас — это то, что не даёт одной ошибочно набранной цифре стать значением, по которому действует покупатель, и это защищает ваше имя больше, чем наше. Задержанные цены обычно освобождаются в тот же день.

Строки независимы. Плохая строка не отклоняет весь пакет.

Считайте то, что мы храним

curl https://bunkerfuelprices.com/api/v1/supplier/prices \
  -H "Authorization: Bearer bfps_YOUR_KEY"

Возвращает ваши последние сто отправок с их статусом, чтобы вы могли сверяться, не ведя собственный журнал того, что мы приняли.

Публичная ценовая доска

Открыта, ключ не нужен, и полезна для проверки того, как ваша цена соотносится с остальным рынком, прежде чем вы её разместите.

curl "https://bunkerfuelprices.com/api/v1/prices?grade=VLSFO&limit=50"

Ошибки и лимиты

До 200 цен на запрос. Размещайте так часто, как хотите — большинство десков размещают один раз утром и ещё раз, если рынок движется. Повторное размещение того же порта и сорта заменяет прежнюю цену, а не дублирует её.