From 0d1b35edc56279bc6e1f94da25afc8d3374b2aa3 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Sat, 25 Feb 2023 10:53:54 +0100 Subject: [PATCH] docs: Explain OAuth preference for app connections --- packages/docs/pages/build-integrations/auth.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/docs/pages/build-integrations/auth.md b/packages/docs/pages/build-integrations/auth.md index 26dfebe5..226d0c6d 100644 --- a/packages/docs/pages/build-integrations/auth.md +++ b/packages/docs/pages/build-integrations/auth.md @@ -93,6 +93,10 @@ We have defined two fields for the auth. You have to add a screen name field in case there is no API endpoint where you can get the username or any other information about the user that you can use as a screen name. Some of the APIs have an endpoint for this purpose like `/me` or `/users/me`, but in our example, the cat API doesn't have such an endpoint. ::: +:::danger +If the third-party service you use provides both an API key and OAuth for the authentication, we expect you to use OAuth instead of an API key. Please consider that when you create a pull request for a new integration. Otherwise, we might ask you to have changes to use OAuth. To see apps with OAuth implementation, you can check [examples](/build-integrations/examples#_3-legged-oauth). +::: + ## Verify credentials So until now, we integrated auth folder with the app definition and defined the auth fields. Now we need to verify the credentials that the user entered. We will do that by defining the `verifyCredentials` method.