MySafe APIs

This document contains information about what MySafe APIs are, how they work, and their main use cases.

What are MySafe APIs?

MySafe APIs were developed to provide programmatic access and management of personal and team corporate data stored in MySafe, ensuring the maintenance of information integrity and confidentiality. Operating as a REST-based solution, they offer integration features with third-party applications for querying, creating, updating, activating, and deactivating passwords, notes, and API secrets.

Functionalities

MySafe APIs functionalities include:

• Passwords API: access one or a list of saved passwords; create, update, activate, and deactivate passwords.

• Notes API: access one or a list of saved notes; create, update, activate, and deactivate a note.

• API secrets API: access one or a list of saved API secrets; create, update, activate, and deactivate an API secret.

Applicabilities

MySafe APIs serve as a bridge for integration with third-party applications, enabling developers to programmatically access items stored within MySafe. The main function of these APIs is to facilitate this access and ensure all the benefits that MySafe provides. These benefits include:

Protection against data leaks

MySafe is crucial in safeguarding passwords, notes, and API secrets, as well as preventing leaks of sensitive information. By adopting this solution, organizations can strengthen their defenses against cyber threats and ensure the confidentiality of critical data.

Secure team collaboration

Beyond secure storage, MySafe provides a safe way to share data among team members. This promotes efficient collaboration while maintaining control over who has access to specific information.

Management of access to privileged information

MySafe offers advanced features to control and manage access to privileged information. This functionality ensures that only authorized users can access confidential data, reinforcing the organization's security policies.

MySafe APIs configuration and use

To use the APIs effectively, it’s important to understand the aspects of authorization and authentication, as well as recommended practices for requests, responses, and potential errors.

Authorization

The authorization for MySafe APIs is performed directly in the module. For more information, access the How to add an access key authorization document.

Authentication

Authentication in the MySafe APIs is conducted using the OAuth 2.0 authentication method. To initiate this process, users need to provide the Client ID and Client Secret, as well as obtain their authentication token from the endpoint:

GET /api/oauth2/token

For more information on how to obtain the Client ID and the Client Secret, access the How to view an access key authorization document.

Requests and responses

Requests are made using HTTP methods such as GET, POST, and PUT. Parameters include identifier, name, username, tags, among others.

For example, to consult a password stored in MySafe, send a request to the following endpoint:

GET /api/mysafe/password/[identifier]

Responses are returned in JSON format, making it easier for applications to parse and work with the data provided by the API.

Errors

The APIs return standard HTTP status codes and include error messages in the response body for easy understanding and troubleshooting.
Refer to the documentation of each API for detailed error code descriptions.

MySafe APIs documentation links

For in-depth details and examples, please refer to the following documents:

• Notes API

• Passwords API

• API secrets API