Describe the authenticated merchant

GET

/v1/me

curl --request GET \
  --url https://open-api.live.gobots.com.br/v1/me \
  --header 'Authorization: Bearer <token>'

Returns the merchant, its tier, the API key in use, the tier limits and the usage of the current cycle.

Authorizations

• ApiKey

Responses

200

The authenticated merchant.

Media typeapplication/json

object

merchant_id

required

string

tier

required

string

Allowed values: starter pro enterprise

api_key

required

object

id

required

string

name

required

string

prefix

required

The public prefix of the key, never the key itself.

string

limits

required

object

rpm

required

object

metrics

required

integer

ads

required

integer

meta

required

integer

monthly_quota

required

integer format: int64

usage

required

object

cycle_start

required

string format: date

cycle_end

required

string format: date

requests

required

integer format: int64

by_group

required

object

key

additional properties

integer format: int64

meta

Present only when the response is degraded.

object

status

required

string

Allowed values: partial

warnings

required

Array<string>

Example

{
  "tier": "starter",
  "meta": {
    "status": "partial"
  }
}

Headers

RateLimit-Policy

required

string

The policies that apply to this endpoint group, as draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.

RateLimit

required

string

The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.

401

The API key is missing, malformed, unknown, revoked or expired.

Media typeapplication/json

object

code

required

Stable machine readable error code.

string

message

required

Human readable explanation. Never carries raw upstream text.

string

retry_after

Seconds to wait before retrying.

integer

limit

Limit that was exceeded.

integer

remaining

Remaining allowance in the current window.

integer

Example ^generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

WWW-Authenticate

string

Bearer challenge for the API realm.

403

The merchant does not have the Open API add-on active.

Media typeapplication/json

object

code

required

Stable machine readable error code.

string

message

required

Human readable explanation. Never carries raw upstream text.

string

retry_after

Seconds to wait before retrying.

integer

limit

Limit that was exceeded.

integer

remaining

Remaining allowance in the current window.

integer

Example ^generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

429

The requests-per-minute limit of the endpoint group was exceeded (rate_limited), or the monthly request quota of the merchant is exhausted (quota_exceeded).

Media typeapplication/json

object

code

required

Stable machine readable error code.

string

message

required

Human readable explanation. Never carries raw upstream text.

string

retry_after

Seconds to wait before retrying.

integer

limit

Limit that was exceeded.

integer

remaining

Remaining allowance in the current window.

integer

Example ^generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

RateLimit-Policy

required

string

The policies that apply to this endpoint group, as draft-ietf-httpapi-ratelimit-headers policy members: "<group>";q=<quota>;w=<window seconds>.

RateLimit

required

string

The state of the endpoint group’s window: "<group>";r=<remaining>;t=<seconds to reset>.

Retry-After

required

integer

Seconds to wait before retrying, per RFC 9110.

500

An unexpected internal error.

Media typeapplication/json

object

code

required

Stable machine readable error code.

string

message

required

Human readable explanation. Never carries raw upstream text.

string

retry_after

Seconds to wait before retrying.

integer

limit

Limit that was exceeded.

integer

remaining

Remaining allowance in the current window.

integer

Example ^generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

503

The upstream source is unavailable. When the merchant’s entitlement could not be resolved the request is refused before rate limiting, so the RateLimit headers are absent.

Media typeapplication/json

object

code

required

Stable machine readable error code.

string

message

required

Human readable explanation. Never carries raw upstream text.

string

retry_after

Seconds to wait before retrying.

integer

limit

Limit that was exceeded.

integer

remaining

Remaining allowance in the current window.

integer

Example ^generated

{
  "code": "example",
  "message": "example",
  "retry_after": 1,
  "limit": 1,
  "remaining": 1
}

Headers

RateLimit-Policy

string

As the RateLimit-Policy response header; absent when entitlement could not be resolved.

RateLimit

string

As the RateLimit response header; absent when entitlement could not be resolved.