Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS ScmProviders API

The ScmProviders API from iOS — 4 operation(s) for scmproviders.

iOS ScmProviders API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ScmProviders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 4 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

4 operations 4 paths 18 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS ScmProviders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

ScmProviders 4
GET
/v1/scmProviders
List Scm Providers
scmProviders_getCollection 2 params → 400401403200429
GET
/v1/scmProviders/{id}
Get Scm Providers
scmProviders_getInstance 2 params → 400401403404200429
GET
/v1/scmProviders/{id}/relationships/repositories
List Related Scm Providers / Repositories
scmProviders_repositories_getToManyRelationship 2 params → 400401403404200429
GET
/v1/scmProviders/{id}/repositories
List Related Scm Providers / Repositories
scmProviders_repositories_getToManyRelated 7 params → 400401403404200429

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ScmRepository (5 properties), ScmProvider (5 properties), ScmGitReference (5 properties), ScmRepositoriesResponse (4 properties). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
ScmProvider
object
5 properties 2 required
PagedDocumentLinks
object
3 properties 1 required
RelationshipLinks
object
2 properties
ScmGitReference
object
5 properties 2 required
ResourceLinks
object
1 property
ScmRepository
object
5 properties 2 required
ScmProviderResponse
object
2 properties 2 required
ScmRepositoriesResponse
object
4 properties 2 required
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
ScmProviderRepositoriesLinkagesResponse
object
3 properties 2 required
ErrorResponse
object
1 property
ErrorSourcePointer
object
1 property 1 required
ScmProvidersResponse
object
3 properties 2 required
ScmProviderType
object
3 properties
CiGitRefKind
string
PagingInformation
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-scmproviders-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API