{"repo":"openpodcast/api","free":true,"listed":false,"github":"https://github.com/openpodcast/api","clone":"git clone https://github.com/openpodcast/api.git","description":"OpenPodcast API server","language":"TypeScript","stars":12,"topics":["analytics","api","metrics","podcast"],"license":null,"category":"analytics","readme_excerpt":"OpenPodcast API This thin API layer is used to store POST ed payloads to the main storage system of Open Podcast. Getting Started - Run make install-init - Start dev server with make dev - Create .env file based on env.example and change the credentials to access the database. For a docker compose setup have a look at https://github.com/openpodcast/stack - In a new window, run e.g. make send-api-req-local to send a test request to the local dev server (result is stored to DB). Connector Format Feedback API (thumbs up/down) The feedback API retrieves thumbs up/down votes from listeners. It stores one unique vote for each episode per IP and user-agent pair. Endpoint /feedback/:episodeID/[upvote downvote] e.g. /feedback/123456/upvote Status API The status API returns the last imports by endpoint: To query it, use the following endpoint: /status Tools to create (JSON) schemata - - Development Testing Run all tests: Run a specific test by name, dev and db server must be running: For example, to run only the authentication test: DB - make up-db starts the db and inits basic auth related tables - make dev starts the dev server which also creates the tables using migrations - to finalize the auth data run make init-auth-db which creates the auth structures","default_branch":null,"files":null,"tree":[],"storefront":"/r/openpodcast","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/openpodcast/api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}