Sign in

Create interface

POST https://{organization}.myguper.com/api/integration/interface

Activates a new integration for the org. slug must be unique inside (organization, slug). activated accepts a boolean: true sets the current timestamp, false (or omitted) leaves it null (= integration registered but not yet enabled).

Try-it values populated from environment ACME (Demo)


Authentication

Signature

Server-to-server RSA signature in the signature header plus User-Agent identifying the caller service. Same scheme used by every other internal Guper API (loyalty, register, order, etc.). No user token — this service is consumed only by other services and by the admin panel through its proxy.

Headers

Name Type Description
signature * string RSA signature `account.service.token` validated against the org public key.
User-Agent * string Caller service name (e.g. `middleware`, `loyalty`).
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "slug": "ecommerce",
    "name": "E-commerce",
    "source": "vtex",
    "activated": "true"                                         // optional
}

Responses

{"id": 102, "organization": "xpto", "slug": "ecommerce", "name": "E-commerce", "source": "vtex", "activated": "2026-06-24T12:00:00+00:00"}
Copied to clipboard