Skip to content

Commit

Permalink
Add some notes about API keys towards the top of the my-apps page
Browse files Browse the repository at this point in the history
  • Loading branch information
big213 committed Apr 14, 2021
1 parent 3653336 commit 1e3b6f0
Showing 1 changed file with 50 additions and 8 deletions.
58 changes: 50 additions & 8 deletions frontend/pages/my-apps.vue
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
<template>
<CrudRecordPage
:record-info="recordInfo"
:locked-filters="lockedFilters"
:hidden-filters="hiddenFilters"
:head="head"
:title="title"
:icon="icon"
></CrudRecordPage>
<div>
<v-container fluid style="max-width: 1920px">
<v-row justify="center" class="pt-3">
<v-col :key="-1" cols="12" class="pb-0">
<v-alert dense type="error">
Do not share your API Keys with anyone or any application that you
don't trust -- your API Key could allow for
<strong>complete access</strong> to the data on your CubePB.com
account.
</v-alert>
<p>
API Keys are used to identify yourself when you are calling the
CubePB.com APIs from 3rd party applications. This is mostly for
developers who want to build apps that can communicate directly with
the CubePB backend APIs.
</p>
<span>
All CubePB.com API requests should be directed as a HTTP POST
request to
<span class="preformatted">https://api.cubepb.com/giraffeql</span>
. The API Key needs to be passed as a header with the key
<span class="preformatted">x-api-key</span>
. The request body must be sent as JSON. Official documentation of
all the API functiaonlity is not currently available, but you can
see what the JSON body looks like for various kinds of actions by
looking at the Request Payload in the developer console of your
browser while performing those actions on the site. For help
regarding setting up the requests, please feel free to drop by our
<a href="https://discord.gg/72d8gNq7bh" target="_blank"
>Discord server</a
>.
</span>
</v-col>
</v-row>
</v-container>
<CrudRecordPage
:record-info="recordInfo"
:locked-filters="lockedFilters"
:hidden-filters="hiddenFilters"
:head="head"
:title="title"
:icon="icon"
></CrudRecordPage>
</div>
</template>

<script>
Expand Down Expand Up @@ -46,3 +82,9 @@ export default {
},
}
</script>
<style scoped>
.preformatted {
font-family: monospace;
white-space: pre;
}
</style>

0 comments on commit 1e3b6f0

Please sign in to comment.