service-provider-apis is an npm package that provides the APIs necessary for exposing services using the 'SAP Service Center'.
To add this package as a dependency in your package.json file, under the "dependencies" section, add the following dependency: "@sap/service-provider-apis": [Version]
This object exposes APIs for the exploration of SAP systems and services.
This API retrieves a list of services from a specific provider system.
getServices(options?: Record<string, any>): Promise<Service[]>;
options (this is optional): The following parameters are optional:
credentials (this is optional): for services that require authentication.
filter (this is optional): used to filter for relevant services.
throws ServiceProviderError: If there is an error, this throws a "ServiceProviderError" error message.
This API retrieves the metadata of a specific service.
getMetadata( service: Service, encoding: EncodingMode, options?: Record<string, any>, relativeUrl?: string, credentials?: Authentication ): Promise<ServiceMetadata>;
service: Defines the service from which the metadata will be retrieved.
encoding: Defines the required encoding requested by the consumer.
options (this is optional): The following parameters are optional:
credentials (this is optional): for services that require authentication.
filter (this is optional): used to filter for relevant services.
relativeUrl (this is optional)*: for a non-full URL - provides the relative URL to the service.
throws ServiceProviderError: If there is an error, this throws a "ServiceProviderError" error message.
This API retrieves the annotations of a specific service.
getAnnotations(service: Service, options?: Record<string, any>): Promise<Annotation[]>
service: Defines the service from which the metadata will be retrieved.
options (this is optional): The following parameters are optional:
credentials (this is optional): for services that require authentication.
throws ServiceProviderError: If there is an error, this throws a "ServiceProviderError" error message.
This API retrieves data for a specific service's entity.
getJsonLiveData(service: Service, entity: string, options?: Record<string, any>): Promise<ServiceCommon>
service: The service for which to return the entity's data.
entity: The name of the entity for which we are retrieving the data.
options (this is optional): The following are optional:
credentials: For services that require authentication.
relativeUrl: The relative path to the service (used in a non-full URL service).
filter: A map of OData request parameters that affect the data response for the entity.
for example: new Filter(new Map([["$top", ["2"]]]])) returns only the two top data rows.
throws ServiceProviderError: If there is an error, this throws a "ServiceProviderError" error type.
Create credentials object - used to access a system or service that requires authentication
const credentials = getCredentialsObject("username", "password");
-
credentials: an object that enables you to add credentials to your system request.
USER: system username
PSW: system password
Credentials can be built as follows:
credentials = new Authentication(, );
Create a filter object - used to filter for needed services
const filter = getNewFilter("protocol", ["odatav2"]);
-
filter: an object that enables you to filter for systems that you want to receive.
FILTER_KEY: (string) A key used to filter the list of systems.
FILTER_VALUES: (array of strings) accepted values of the filter key, separated by commas.
Filters can be built as follows:
filter = new Filter(new Map([[<FILTER_KEY>, <FILTER_VALUES>]]));
- Open Git Bash, go to the local repository directory and sync with the remote repository.
- Develop in a Local branch.
- Create a new descriptive branch
git checkout -b my-local-branch-name
OR rename the previous onegit branch -m my-local-branch-name. - Make sure my-local-branch-name is NOT master and that there is no existing branch with this name.
- Sync with the remote repository.
- Fetch the code from the master branch by running
git fetch; git merge.
- Make your local changes.
- Run
npm installto install dependencies. - Run
npm run testto compile the TypeScript code to JavaScript and run tests.
- Commit and push.
- Do not push directly to master!!!
- Commit your changes and push to create a new branch on GitHub by running
git push origin my-local-branch-name - On consecutive commits DO NOT use
commit amend. You should create a new commit and push to the same feature branch again. This will add an extra commit to your pull request and retrigger the voters.
- Open a pull request.
- Click 'New pull request' next to your branch.
- Edit the pull request name with BLI or BCP. For example: "BLI DEVXCORE-123: my new feature" or "BCP 1670451810: Fix my bug".
- A new branch (my-local-branch-name) is created in the GitHub repository.
- The new code should enable all voters and code review to pass successfully.
- Update the existing pull request.
- Stage your changes and create a new commit.
- Perform Git fetch.
- Perform Git merge on origin/master - Merge your changes with the most updated master branch.
- Push your changes to your my-local-branch-name (Git push origin my-local-branch-name).
- Merge the pull request.
- If all voters passed (XMake + JaaS Voter), click 'Merge pull request'.
- If your pull request contains several commits, you combine them in one commit from GitHub by selecting the 'Confirm squash and merge' option from the Merge dropdown list.
- Delete your branch.
- After the merge is complete, go to Code > Branches.
- Look for your merged pull request and click the delete branch icon.
- Run
npm run testto run the unit tests written in Mocha and the coverage test.
Bump the version in the "package.json" GitHub file.
Notes: Make sure to follow this versioning concept:
- When providing new features (when releasing at end of the sprint or when a new feature is ready), bump a major version (for example, from 1.1.0 to 1.2.0).
- When providing a bug fix to an existing version ("hotfix"), bump a minor version (for example, from 1.1.0 to 1.1.1).