Документация API

REST API совместимый с SendGrid для отправки транзакционных писем.

Базовый URL: https://chorizo.online
POST /v3/mail/send 202

Отправить email в формате payload, совместимом с SendGrid.

curl -X POST https://chorizo.online/v3/mail/send \
  -H "Authorization: Bearer SG.your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "personalizations": [
      {
        "to": [{"email": "user@example.com", "name": "User"}],
        "subject": "Hello World"
      }
    ],
    "from": {"email": "noreply@yourdomain.com", "name": "My App"},
    "content": [
      {"type": "text/plain", "value": "Hello!"},
      {"type": "text/html", "value": "<h1>Hello!</h1>"}
    ]
  }'
POST /v3/bounce 200

Обработать уведомления о возвратах и добавить получателей в список подавления.

curl -X POST https://chorizo.online/v3/bounce \
  -H "Content-Type: application/json" \
  -d '{
    "recipients": ["bounced@example.com"],
    "reason": "Mailbox not found"
  }'
GET /v3/stats 200

Получить статистику отправки за период.

ParameterTypeDescription
daysintКоличество дней (1-365, по умолчанию 30)
domain_idintФильтр по домену (необязательно)
 
curl "https://chorizo.online/v3/stats?days=7" \
  -H "Authorization: Bearer SG.your-api-key"
POST /v3/templates 201

Создать новый шаблон письма.

curl -X POST https://chorizo.online/v3/templates \
  -H "Authorization: Bearer SG.your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "welcome",
    "subject": "Welcome, !",
    "html_content": "<h1>Hello </h1><p>Welcome aboard.</p>"
  }'
GET /v3/templates 200

Список всех шаблонов для текущего API-ключа.

curl "https://chorizo.online/v3/templates" \
  -H "Authorization: Bearer SG.your-api-key"
GET /v3/templates/{template_id} 200

Получить шаблон по ID.

curl "https://chorizo.online/v3/templates/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer SG.your-api-key"
PATCH /v3/templates/{template_id} 200

Обновить шаблон по ID. Отправляйте только изменяемые поля.

curl -X PATCH https://chorizo.online/v3/templates/550e8400-... \
  -H "Authorization: Bearer SG.your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"subject": "Updated subject"}'
DELETE /v3/templates/{template_id} 204

Удалить шаблон по ID.

curl -X DELETE https://chorizo.online/v3/templates/550e8400-... \
  -H "Authorization: Bearer SG.your-api-key"

Коды ответов

200 Успех
201 Создано
202 Принят к доставке
204 Удалено (без содержимого)
400 Невалидный payload запроса
401 Невалидный или отсутствующий API-ключ
403 Получатель заблокирован правилами ACL
404 Ресурс не найден
409 Конфликт (дублирующееся имя)
429 Превышен лимит запросов

Нужна помощь?

Написать в поддержку