Publieke API
Blueputto Publieke API voor geauthenticeerde CRUD-toegang tot workspace-records, met geversioneerde endpoints, API-sleutels, paginering, filters en workflowacties.
Grzegorz
De Publieke API is Blueputto's geauthenticeerde integratielaag. Ze stelt dezelfde kernrecords bloot waarmee de applicatie dagelijks werkt, waardoor externe systemen operationele gegevens kunnen aanmaken, lezen, bijwerken en verwijderen zonder naast de UI een tweede contentmodel te introduceren.
Deze API draait onder /v1 en is ontworpen om te werken met organisatiebrede API Keys. Daardoor gebruiken teams deze functie wanneer Blueputto-gegevens naar een website, automatisering, importscripts, intern dashboard of een ander productsysteem moeten worden verplaatst.
Eén geversioneerde API voor de belangrijkste workspace-resources
Het ingangspunt op /v1 retourneert een compacte discovery-payload met de API-versie, het authenticatieformaat, de URL van het OpenAPI-document en de lijst met momenteel beschikbare resources.
In de huidige implementatie omvat het publieke oppervlak:
documents,
items,
collections,
folders,
categories,
statuses,
labels,
en document templates.
De meeste van die resources ondersteunen het standaard operationele pad van lijst, ophalen, aanmaken, bijwerken en verwijderen. De API stelt ook workflowspecifieke acties beschikbaar waar de UI die nodig heeft, zoals:
herstellen en permanent verwijderen voor documents en items,
dupliceren voor documents,
herordenen voor categories, statuses en labels,
en alleen-actief-filtering voor document templates.
Dat is wat de Publieke API meer maakt dan een alleen-lezen-exportlaag. Ze sluit nauw aan op de werkelijke levenscyclus van records die al zichtbaar is in Blueputto zelf.
Authenticatie en responsvorm blijven voorspelbaar
De Publieke API accepteert de organisatiecredential in een van twee standaardvormen:
x-api-key,
of Authorization: Bearer <key>.
Dat geeft teams flexibiliteit bij het koppelen van Blueputto aan verschillende runtimes, gateways en SDK-stijlen. De sleutel zelf wordt binnen de applicatie aangemaakt via de instellingenpagina API Keys.
Ook de responsvorm is bewust consistent. Responses voor één resource worden teruggegeven binnen een data-envelop. Lijst-endpoints retourneren data samen met meta, waaronder pagineringsdetails zoals page, limit, total items, total pages en de status van de volgende of vorige pagina.
Binnen de huidige set resources stelt de API ook praktische filters beschikbaar die echte UI-workflows weerspiegelen, waaronder search, deletedOnly, folderId, withoutFolder en activeOnly.
Gebouwd rond dezelfde operationele regels als de app
Het nuttige aan Blueputto's Publieke API is niet alleen dat records extern bereikbaar zijn. Het is dat het integratieoppervlak dezelfde regels volgt die het product al afdwingt in de UI.
Zo zijn het verwijderen van documents en items gemodelleerd als een eerst-naar-prullenbak-flow in plaats van onmiddellijke vernietiging. Sommige documentbewerkingen kunnen een locked-state-respons retourneren wanneer het record momenteel niet bewerkbaar is. Rate limiting wordt afgedwongen per API-sleutel, waarbij de standaard backendlimiet momenteel is ingesteld op 5 req/s per sleutel.
Dat houdt de API in lijn met echt applicatiegedrag. Externe integraties werken met Blueputto's daadwerkelijke resourcemodel, niet met een vereenvoudigd zijkanaal dat zich anders gedraagt dan het product.
