Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: YourMembership Authentication API
description: A description of the YourMembership developer API surface.
version: '1.0'
contact:
name: YourMembership (Momentive Software)
url: https://www.yourmembership.com/api/
servers:
- url: https://ws.yourmembership.com
description: YourMembership REST API (YM AMS)
- url: https://api.careerwebsite.com/v1
description: YMCareers REST API (job board / career center)
security:
- oauth2: []
tags:
- name: Authentication
description: OAuth authentication for the YM REST API.
paths:
/Ams/Authenticate:
post:
tags:
- Authentication
summary: Authenticate and obtain a session/token
description: Authenticate to the YourMembership REST API. Confirmed endpoint. Returns the session context / token subsequently presented on /Ams requests. Requires that the organization has licensed the REST API.
operationId: authenticate
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
apiKey:
type: string
description: Licensed API key issued to the organization.
saPasscode:
type: string
description: System administrator passcode where required.
responses:
'200':
description: Authenticated. Returns a session token.
'401':
description: Authentication failed or REST API not licensed.
components:
securitySchemes:
oauth2:
type: oauth2
description: OAuth authentication for the YM REST API, established via POST /Ams/Authenticate. The YMCareers API instead uses an API_ACCESS_TOKEN (15-minute) Authorization header or a non-expiring X-API-KEY header.
flows:
clientCredentials:
tokenUrl: https://ws.yourmembership.com/Ams/Authenticate
scopes: {}