Earnberry
by earnberry

Earnberry

Earnberry v1. Авторизация происходит по заголовку X-Earnberry-API-Key.

Base URI

https://earnberry.net/api
API Methods
Новая транзакция
POST /conversion_push
Нотификация
POST /conversion_update_total
Данные транзакции
GET /conversion_info
Новая транзакция
POST /conversion_push

Метод для создания транзакции в системе Earnberry.

Request body

Object
trackingId
string

Обязательное поле. Идентификатор клиента.

Example:
12
cart
Object

Обязательно поле. Список товаров чека.

sku
string
Example:
1
name
string
Example:
Пылесос Ракета
category
string
Example:
Техника СССР
price
number
Example:
350
quantity
number
Example:
2
dry_run
boolean
Example:
false
total
number
Example:
50
orderId
string
Example:
221ab
tax
number
Example:
10
city
string
Example:
Kharkiv
state
string
Example:
Kharkivska oblast
shipping
number
Example:
5
country
string
Example:
Ukraine
currency
string
Example:
UAH
grossprofit
number
Example:
100
marker
string

Опционально. Маркер используеться для разделения транзакций по способу их заказа. Например для заказов созданных менеджером через crm ставят маркер crm, а полученных через витрину - order. Значения маркеров могут быть любыми, используются в статистике Earnberry.

Example:
order

Responses

200 OK
Body
Object
result
string

“OK” если запрошенное действие выполнено. “ERROR” если есть проблемы с выполнением действия. Подробнее об ошибках смотреть в поле “errors”

Example:
OK
orderId
string

Если транзакция была создана, то в этом поле будет ее идентификатор.

Example:
errors
string

Список ошибок. Только если result = “ERROR”.

Example:
dry
string

Если используется “dry_run” , то будет “OK”. Если нет, то этого поля не будет.

Example:
OK

Examples

Для авторизации в запрос нужно добавить заголовок X-Earnberry-API-Key.

POST https://earnberry.net/api/conversion_push HTTP/1.1 

Content-Type: application/json

{
  "trackingId" : "12",
  "cart" : [ {
    "sku" : "1",
    "name" : "Пылесос Ракета",
    "category" : "Техника СССР",
    "price" : 350,
    "quantity" : 2
  } ],
  "dry_run" : false,
  "total" : 50,
  "orderId" : "221ab",
  "tax" : 10,
  "city" : "Kharkiv",
  "state" : "Kharkivska oblast",
  "shipping" : 5,
  "country" : "Ukraine",
  "currency" : "UAH",
  "grossprofit" : 100,
  "marker" : null
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "result" : "OK",
  "orderId" : "221ab"
}
Нотификация
POST /conversion_update_total

Для обновление сумм прибыли о оборота транзакции по ее идентификатору.

Request body

Object
orderId
string

Обязательное поле. Идентификатор изменяемой транзакции.

Example:
112ab
total
number

Обязательно поле. Новая сумма прибыли.

Example:
1115.1
grossprofit
number

Обязательно поле. Новая сумма оборота.

Example:
2000
currency
string

Опционально. Валюта сумм прибыли и оборота.

Example:
UAH

Responses

200 OK
Body
Object
result
string

“OK” , если все прошло успешно, “ERROR”, если возникли проблемы. Текст ошибки в поле “errors”

Example:
OK
errors
string

Текст ошибки, если она возникла при изменении суммы.

Example:

Examples

POST https://earnberry.net/api/conversion_update_total HTTP/1.1 

Content-Type: application/json

{
  "orderId" : "221ab",
  "total" : 1115.1,
  "grossprofit" : 2000,
  "currency" : "UAH"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "result" : "OK"
}
Данные транзакции
GET /conversion_info

Информации о транзакции.

Request parameters

orderId
string required

Обязательное поле. Идентификатор транзакции.

Example:
123ab

Responses

200 OK
Body
Object
result
string

“OK” , если все прошло успешно, “ERROR”, если возникли проблемы. Текст ошибки в поле “errors”

Example:
OK
data
Object

Данные полей транзакции.

status
number

1 - не удалось связать заказ с источником

2 - заказ связан с источником

3 - ошибка на сервере

Example:
1
is_testing
boolean

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

Example:
false
created_at
number

Время создания транзакции в формате UNIX. Часовой пояс GMT.

Example:
1401881804
marker
string

Маркер транзакции.

Example:
tel
notified_total
number

Прибыль транзакции.

Example:
1500.99
notified_grossprofit
number

Сумма оборота транзакции.

Example:
2700.99
customer_ip
string

IP адрес клиента, если его удалось получить.

Example:
91.214.249.5
tracking_id
string

Код клиента.

Example:
95
order_id
string

Идентификатор транзакции.

Example:
123ab
errors
string

Текст ошибки.

Example:
Params error: conversion for this order_id doesnt exists.

Examples

Для авторизации в запрос нужно добавить заголовок X-Earnberry-API-Key.

GET https://earnberry.net/api/conversion_info?orderId=123ab HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
  "result" : "OK",
  "data" : {
    "status" : 2,
    "is_testing" : true,
    "created_at" : 1401881804,
    "marker" : "tel",
    "notified_total" : 1500.99,
    "notified_grossprofit" : 2700.99,
    "customer_ip" : "91.214.249.5",
    "tracking_id" : "95",
    "order_id" : "123ab"
  }
}