Utvecklare

Fråga en butik vad den kan göra, från din egen assistent.

Varje butik på Specify svarar på ett API byggt för AI-assistenter. Det ger samma svar som butiken ger en kund. Inget gissas på vägen.

Samma svar som butiken

En assistent frågar om en butik kan göra något. API:t frågar samma kod som butiken frågar.

Så de två svaren förblir lika. Ett test skickar samma fråga till båda och jämför svaren byte för byte.

Ett nej kommer med butikens egna ord. Ett pris är butikens egen siffra, eller ingen siffra alls.

Fem rutter

Varje sökväg börjar med butikens namn, dess slug. Ingen rutt kräver en API-nyckel.

GET /api/agent/v1/{merchantSlug}/capability
Vad butiken kan göra: val, enheter och intervall. Och de produkter du kan fråga om.
POST /api/agent/v1/{merchantSlug}/offer
Skicka valda alternativ. Få tillbaka ja eller nej, skälen och priset.
POST /api/agent/v1/{merchantSlug}/offer/from-intent
Skicka en mening i stället. Få samma svar, och vad som förstods.
POST /api/agent/v1/{merchantSlug}/opportunities
Skicka en förfrågan om något som butiken inte erbjuder än. Butiken svarar på den.
POST /api/agent/v1/{merchantSlug}/orders
Lägg en order som en kund bad om, till det pris som kunden godkände.

OpenAPI-dokumentet

Rutterna beskrivs i ett OpenAPI-dokument. Det skapas från koden, så det kan inte glida isär från den. Det täcker de fem rutterna och inget annat.

https://api-dev.specify.digital/openapi/agent.json

Öppna OpenAPI-dokumentet

Det här kan du lita på

  • Inga påhittade priser

    Ett pris är fast, uträknat eller kräver en människa. I det sista fallet skickas ingen siffra.

  • En nyckel, en order

    Varje order har en nyckel som din kod hittar på. Skicka den igen efter ett förlorat svar, så får du samma order tillbaka.

  • Priset som kunden godkände

    Ange totalen som kunden godkände. Om priset har ändrats läggs ingenting. Svaret ger den nya totalen.

  • Fel som du kan agera på

    Varje fel har en fast kod, och varje kod säger vad du ska göra. Koder byter aldrig namn.

  • Ändringar lägger bara till

    Versionen står i sökvägen. Inom en version lägger ändringar bara till. Ett test jämför varje ändring med den senast publicerade formen.

  • Frågor, inte en utskrift

    En assistent kan fråga om ett val som butiken inte visar. Den kan inte få alla uppräknade.

API-nycklar

Agent-API:t kräver ingen API-nyckel. Det är byggt för alla assistenter. Varje rutt har en gräns per adress. Ett upptaget svar säger när du kan försöka igen.

Butikens egna system är något annat. Ägare och administratörer skapar en API-nyckel för vart och ett. Det görs i administrationen, under API-nycklar. En API-nyckel visas en gång och kan återkallas.

Inte byggt än

API-dokumentationen räknar upp dessa, och det gör vi också.

  • En assistent kan inte betala åt kunden. Kunden betalar på butikens egen betalningssida.
  • En mening läses en tur i taget. Det finns inget samtal fram och tillbaka.
  • En assistent lägger en order som en kund bad om. Den bestämmer inte själv att köpa.

Prova det mot en egen butik

Lägg upp en butik med en produkt och dess val. Peka sedan din assistent mot den.

Skapa din butik Läs hur det fungerar

För att registrera dig ber vi om din jobbmejl och ditt företagsnamn.