vernonkeenan
/
lib
mirror of https://github.com/vernonkeenan/lib
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lib/client/board/docs/DevelopersApi.md

1.5 KiB
Raw Blame History

Board.DevelopersApi

All URIs are relative to http://board.vernonkeenan.com:8080/v1

Method HTTP request Description
postDevelopers POST /developers Onboard new developer

postDevelopers

RuleExecution postDevelopers(developerRequest)

Onboard new developer

Register new developers with POST

Example

import Board from 'board';
let defaultClient = Board.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new Board.DevelopersApi();
let developerRequest = new Board.Developer(); // Developer | A single Developer struct for onboarding
apiInstance.postDevelopers(developerRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
developerRequest Developer A single Developer struct for onboarding

Return type

RuleExecution

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json