Getting started with Meveto
Last updated: Feb 6, 2020
To setup your application with Meveto, you will first need to sign up with Meveto as a Business. After that you will be able to register your application from your dashboard. Upon successful registration, Meveto will give you 2 important pieces of information that your application will need to interact with Meveto APIs. The two pieces of information are application ID
and application secret.
Remember
Your application secret
will only be displayed on your screen once. There's no way to get it back if you ever lose it or if you don't save it before closing your browser window. Therefore, make sure you save it and you never lose it.
At the time of registration of your application, the following information is required and it is necessary that you understand what it is and why it's required.
- Application type
- Application name
- Application description
- Application web address
- Application login URL
- Application redirect URL
- Application webhook URL
- Application account sharing
Application type
This specifies the type of your application. This information allows Meveto to make certain integration decisions based on the type of your application. There will be many different application types added in the near future but for now you can choose between WordPress
and Other.
If your application is based on WordPress, Meveto will fill Application login URL
and Application webhook URL
based on your Application web address
because Meveto has already taken care of it in its WordPress plugin which you will need to install in your application to integrate Meveto.
Application name
This is the name of your application that will appear on the dashboard of Meveto users. Make sure to keep it short, ideally one or two words long. This will allow users to easily identify your application when they login to their Meveto accounts. Remember that Meveto allows users to login, logout, share account or remove your application from their Meveto dashboard.
Application description
A short description of your application. What it is and what it does and who is it for, usually 3 to 5 lines long text is perfect for this purpose. Users will be able to read this description.
Application web address
The primary web address of your application that is typically used by your users to access your application. Make sure to provide the base URL of your application such as https://meveto.com
and not a sub domain or parameterized address. This is especially important if your application is WordPress based because Meveto will then reach out to this address during OAuth handshakes and when sending webhook calls. For other applications or websites that are not based on WordPress, this address is not important for integration.
Application login URL
This information will be filled out by Meveto based on your application's base URL, if your application type is WordPress. Otherwise, this is the URL that Meveto will take users to when they want to login to your application using Meveto dashboard. Therefore, make sure that this URL is reachable and that the login process of your application starts at this address. Typically, this address is supposed to serve your application's login page to users.
Application redirect URL
This is the URL that Meveto will redirect to when initiating an OAuth handshake with your application. After a user is successfully authenticated by Meveto, the rest of the login process to your application will be handed over to this URL.
Application webhook URL
This is another very important URL that Meveto will use to send out webhook calls to your application. Meveto sends webhook calls when a certain event occurs. For example, when a user requests logout from their Meveto dashboard, Meveto will deliver requests to this URL. Meveto will send a type
attribute in each webhook payload that your application can use to identify the type of request and process accordingly. Read more about the webhook types and how to process them at the webhooks types.
Application account sharing
By default, Meveto allows users to share access to their client application accounts with other Meveto users. Users can set a precise time for sharing, like a few minutes, hours, months or forever. When an account is shared with another Meveto user, that user will then be able to login to your application as the original user of the account. So at your application, it will be the same as if the actual user has logged in to their account. Similar to when a user shares their authentication credentials with another person except, with Meveto, there are no more credentials that needs to be shared. So if you would like to allow your users to be able to share their accounts when they need to, you can choose to allow Meveto to do that. Otherwise, you may disable this default behavior for your application at the time of its registration.