Documentation

 

Getting Started

Stitchz Login provides a simple RESTful api that can be used to authenticate your website users with their social identity provider. A request to an endpoint below initiates the authentication process and generates a unique, time sensitive, token. Post the token back to the Auth endpoint to complete the authentication process and receive the client's social profile.
 

Login API

A request to an endpoint (v1 OR v2) below initiates the authentication process and generates a unique, time sensitive, token. Post the token back to the Auth endpoint to complete the authentication process and receive the client's social profile.
 
Version* Endpoint Description
GET v1 https://<YourStitchzAppUrl>/<LoginProviderName>/v1/Authenticate?ApiKey=<YourStitchzApiKey>&ReturnUrl=<YourAppReturnUrl> Initiate an authentication request with a baisc request including a Stitchz ApiKey and your ReturnUrl. The request should include your application's Url (generated by Stitchz) and the name of the Login Provider (see valid provider names below).
GET v2 https://<YourStitchzAppUrl>/<LoginProviderName>/v2/Authenticate?client_id=<YourStitchzApiKey>&redirect_uri=<YourAppReturnUrl>&scope=<Basic|Professional|Enterprise>&state=<UnqiueRandomString>&response_type=code"; Initiate a new authentication request with a standard OAuth2 formatted request Url including Stitchz client_id, redirect_url, scope, response_type, and state. The request should include your application's Url (generated by Stitchz) and the name of the Provider (see valid provider names below).
Post v1 | v2 /Authenticated/v1/Auth Used to complete the authentication process between your website and Stitchz. Version 2 obtains an OAuth2 token for future RESTful requests
* version calls cannot be mixed
 
Valid Provider Names:

RESTful API

All RESTful API requests must use the app's App URL as provided when the application was setup in the Stitchz Login Settings page and include the user's identity string provided upon authentication with Stitchz Login (unless otherwise stated). RESTful requests must have used version v2 for authentication.
Type Provider Endpoint Category Description
Get/Patch - /api/v2/settings Application Return or update the application's settings as defined on the Stitchz Login Settings page. No user identity string required.
Get - /api/v2/LoginTotal Application Returns total number of logins and login limits related to the website's Stitchz application. No user identity string required.
Get - /api/v2/Providers Application Returns a collection of providers that were setup for the authorized application. No user identity string required.
Get /api/v2/Activities Sharing Returns a list of the authenticated user's activities from the Identity Provider the user is authorized with.
Get/Post /api/v2/Activity Sharing Posts a message on behalf of the authenticated user to their social network.
Get /api/v2/Followers Sharing Returns the total number of followers for the identity.
Get /api/v2/Following Sharing Returns the total number of accounts being followed by the identity.
Get /api/v2/Likes/{id} Sharing Returns the total number of likes for the given post id.
Get /api/v2/Comments/{id} Sharing Returns the total number of comments for the given post id.
Get /api/v2/Artist Music Returns details about the recording artist, or the artist's releases.
Get /api/v2/Artist/Releases Music Returns details about the recording artist, or the artist's releases.
Get/Post/Delete /api/v2/Collection Music Returns a list, adds to the list, or deletes from the list of releases in the authenticated user's collection folder
Get/Post/Delete /api/v2/Collection/Folder/{folderId} Music Returns a list, adds to the list, or deletes from the list of folders in the authenticated user's collection
Get/Post/Delete /api/v2/WantList Music Returns a list, adds to the list, or deletes from the list of releases in the authenticated user's want list
 

Response Errors

 
Error Code Description
1 The user being authenticated has denied or rejected the requested permissions (scope) of the request with the login provider.
2 The user identity is invalid, either has not been authenticated or has never used the service.
3 The request is missing a required parameter and is unable to complete.