How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Socotra Producers API

The Producers API from Socotra — 31 operation(s) for producers.

Socotra Producers API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Producers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 39 operations across 31 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

39 operations 31 paths 31 schemas 11 GET18 PATCH6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
Resource Areas
1

Paths & Operations 39

Across 31 paths, the API surfaces 39 operations — 11 GET, 18 PATCH, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Producers 39
GET
/producers/{tenantLocator}/producers/{producerLocator}
fetchProducer 2 params → 200
PUT
/producers/{tenantLocator}/producers/{producerLocator}
replaceProducer 2 params body → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}
updateProducer 2 params body → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
fetchProducerLicense 3 params → 200
PUT
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
replaceProducerLicense 3 params body → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}
updateProducerLicense 3 params body → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
fetchProducerCode 3 params → 200
PUT
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
replaceProducerCode 3 params body → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}
updateProducerCode 3 params body → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
fetchProducerAppointment 3 params → 200
PUT
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
replaceProducerAppointment 3 params body → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}
updateProducerAppointment 3 params body → 200
POST
/producers/{tenantLocator}/producers
createProducer 1 param body → 200
POST
/producers/{tenantLocator}/producers/{producerLocator}/licenses
createProducerLicense 2 params body → 200
POST
/producers/{tenantLocator}/producers/{producerLocator}/codes
createProducerCode 2 params body → 200
POST
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/set
setCodeByNumber 4 params → 200
POST
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/number/generate
generateCodeByNumber 3 params → 200
POST
/producers/{tenantLocator}/producers/{producerLocator}/appointments
createProducerAppointment 2 params body → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/validate
validateProducer 2 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/unsuspend
unsuspendProducer 2 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/suspend
suspendProducer 2 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/retire
retireProducer 2 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/validate
validateProducerLicense 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/licenses/{producerLicenseLocator}/discard
discardProducerLicense 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/discard
discardProducer 2 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/validate
validateProducerCode 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/unsuspend
unsuspendProducerCode 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/suspend
suspendProducerCode 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/retire
retireProducerCode 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/codes/{producerCodeLocator}/discard
discardProducerCode 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/validate
validateProducerAppointment 3 params → 200
PATCH
/producers/{tenantLocator}/producers/{producerLocator}/appointments/{producerAppointmentLocator}/discard
discardProducerAppointment 3 params → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/producerHierarchy
fetchProducerHierarchy 2 params → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/licenses/list
fetchProducerLicenses 4 params → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/codes/list
fetchProducerCodes 4 params → 200
GET
/producers/{tenantLocator}/producers/{producerLocator}/appointments/list
fetchProducerAppointments 4 params → 200
GET
/producers/{tenantLocator}/producers/list
fetchProducers 3 params → 200
GET
/producers/{tenantLocator}/producers/codes/{code}
fetchProducerCodeByCode 2 params → 200
GET
/producers/events
fetchProducersEventDefinitions → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ProducerAppointmentResponse (15 properties), ProducerLicenseResponse (14 properties), ProducerAppointmentUpdateRequest (11 properties), ProducerLicenseUpdateRequest (10 properties). Each schema is shown below with its type and property counts.

ProducerLicenseCreateRequest
object
8 properties 4 required
ProducersEventTypeDefinitions
object
4 properties 4 required
ProducerLicenseResponse
object
14 properties 9 required
ProducerAppointmentResponse
object
15 properties 10 required
ProducerCodeUpdateRequest
object
5 properties 2 required
ProducerEventData
object
1 property 1 required
ListPageResponseProducerCodeResponse
object
2 properties 2 required
ProducerEvents
object
7 properties
ProducerAppointmentUpdateRequest
object
11 properties 2 required
ProducerCodeEventData
object
2 properties 1 required
ProducerCodeEvents
object
8 properties
ListPageResponseProducerResponse
object
2 properties 2 required
ProducerAppointmentCreateRequest
object
9 properties 5 required
ProducerHierarchyResponse
object
9 properties 6 required
ProducerCreateRequest
object
3 properties 1 required
ProducerLicenseEvents
object
4 properties
ProducerAppointmentEventData
object
1 property 1 required
ProducerCodeCreateRequest
object
3 properties 1 required
ProducerUpdateRequest
object
4 properties 2 required
ProducerAppointmentReplaceRequest
object
10 properties 6 required
ProducerLicenseEventData
object
1 property 1 required
ListPageResponseProducerLicenseResponse
object
2 properties 2 required
ProducerLicenseUpdateRequest
object
10 properties 2 required
ProducerCodeResponse
object
9 properties 6 required
ListPageResponseProducerAppointmentResponse
object
2 properties 2 required
ProducerResponse
object
8 properties 5 required
ProducerLicenseReplaceRequest
object
9 properties 5 required
ProducerAppointmentEvents
object
4 properties
ValidationItemResponse
object
3 properties 3 required
ValidationResult
object
2 properties 1 required
ProducerCodeReplaceRequest
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-producers-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
Socotra Auxdata API
Socotra Billing API
Socotra Business Stats API
Socotra Claim API
Socotra Compliance API
Socotra Config API
Socotra Contact API
Socotra Document API
Socotra Event API
Socotra Migration API
Socotra Payment Execution API
Where this information came from

This is an independent, third-party profile of Socotra Producers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.