The following document describes how to interact with the Goodify Platform through its official APIs.
\nIn order to generate authenticated requests trough its store or e-commerce, the business owner must share its API ID and API Secret credentials, available in its settings panel on Goodify, with the end application. Those credentials are necessary to execute requests on behalf of the business owner.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"13038934","collectionId":"4f27fd19-55ad-4912-99fc-eceb981388d0","publishedId":"TVepAoZ4","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0098DB"},"publishDate":"2020-11-16T16:28:53.000Z"},"item":[{"name":"Get user's data","id":"387623ab-0f29-46a9-9828-2b9c9a0179b0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Ju8Yujpxigmjieqvn3zv5lgmss4xOkli0\",\n \"businessSecret\": \"LHy6u*ezutwLOp7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/users/me","urlObject":{"path":["api","v2","users","me"],"host":["https://api.goodify.com"],"query":[],"variable":[]}},"response":[{"id":"3f0d1206-417b-4153-8826-ee4dc15bf2f8","name":"Successful fetch","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Ju8Yujpxigmjieqvn3zv5lgmss4xOkli0\",\n \"businessSecret\": \"LHy6u*ezutwLOp7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/users/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 08:00:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"109"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"user\": {\n \"id\": \"Op08ucqe5u4x2gf2hy11rwh41mijqwd1\",\n \"name\": \"Deda Group\",\n \"email\": \"dedagroup@email.com\"\n }\n }\n}"},{"id":"db90ac4f-27a0-4ed9-be86-c3a55fb43db1","name":"Authentication failed","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Ju8Yujpxigmjieqvn3zv5lgmss4xOkli0\",\n \"businessSecret\": \"LHy6u*ezutwLOp7\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/users/me"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 08:02:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"387623ab-0f29-46a9-9828-2b9c9a0179b0"},{"name":"Get the list of user's campaigns","id":"8a0aec83-5569-4322-85b2-325da522a282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Poliucqe5u4x2gf2hy11rwh41miKui8O\",\n \"businessSecret\": \"Hy78A4JFwJui8\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/campaigns/","description":"Returns all user's campaigns and their settings.
\nminPurchaseAmount
\nPurchase amount necessary to register the donation as valid.
\ndonationMode
\nCan be either AMOUNT or PERCENTAGE.
\ndonationAmount
\nFixed donation amount for each donation.
\ndonationPercentage
\nIf this field is set, the donation amount will be calculated, based on the purchase amount.
\nmaxDonationAmount
\nIf the donationPercentage field is set, the maximum donation limit is set to the value defined in this field.
\n","urlObject":{"path":["api","v2","campaigns",""],"host":["https://api.goodify.com"],"query":[],"variable":[]}},"response":[{"id":"cb83d2e3-b33c-44a5-adf7-485600e018f7","name":"Successful fetch","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Poliucqe5u4x2gf2hy11rwh41miKui8O\",\n \"businessSecret\": \"Hy78A4JFwJui8\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/campaigns/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 08:07:16 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"257"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"campaigns\": [\n {\n \"id\": \"Uhy7jg108ncaf5gu9dsu44huo2uqJPol\",\n \"name\": {\n \"it\": \"Natale benefico 2021\"\n },\n \"imageUrl\": \"https://goodify-random-public.s3.eu-west-1.amazonaws.com/dedagroup.jpg\",\n \"donationMode\": \"AMOUNT\",\n \"donationAmount\": null,\n \"donationPercentage\": 20\n }\n ]\n }\n}"},{"id":"2556ed21-60de-4c25-8d21-1f15a5bcda4c","name":"Authentication failed","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Ju8Yujpxigmjieqvn3zv5lgmss4xOkli0\",\n \"businessSecret\": \"LHy6u*ezutwLOp7\"\n}"},"url":"https://api.goodify.com/api/v2/campaigns/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 08:06:10 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8a0aec83-5569-4322-85b2-325da522a282"},{"name":"Get the settings of a campaign","id":"23828b37-88c9-485b-ab36-e88c5777f3a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"LLo8ucqe5u4x2gf2hy11rwh41mijLop9\",\n \"businessSecret\": \"0P5zA4JFwxV8V\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/campaigns/:id","description":"minPurchaseAmount
\nPurchase amount necessary to register the donation as valid.
\ndonationMode
\nCan be either AMOUNT or PERCENTAGE.
\ndonationAmount
\nFixed donation amount for each donation.
\ndonationPercentage
\nIf this field is set, the donation amount will be calculated, based on the purchase amount.
\nmaxDonationAmount
\nIf the donationPercentage field is set, the maximum donation limit is set to the value defined in this field.
\n","urlObject":{"path":["api","v2","campaigns",":id"],"host":["https://api.goodify.com"],"query":[],"variable":[{"type":"any","value":"The donationId code can be used to allow the user to track the status of its donation by redirecting him to https://goodify.com/view/REDIRECT_ID.
\n","urlObject":{"path":["api","v2","donations","purchase"],"host":["https://api.goodify.com"],"query":[],"variable":[]}},"response":[{"id":"be33205f-7e6a-4220-ba1d-ce5d16950d44","name":"Successfully created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"Hy67ijpxigmjieqvn3zv5lgmssLo89I0\",\n \"businessSecret\": \"KioSJezutwyJuo\",\n \"campaignId\": \"Jui7fgodlsu5n6clieofye6b8uLopf7J\",\n \"purchaseAmount\": 100,\n \"donatorEmail\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/donations/purchase"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 07:54:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"58"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"redirectId\": \"5hijvcqhgui77v9m40oxteqjrg5e712s\"\n }\n}"},{"id":"f04a8d2c-faf7-4297-bf3e-32cf2baa6713","name":"Authentication failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"businessId\": \"o90kujpxigmjieqvn3zv5lgmss4xopju\",\n \"businessSecret\": \"LiObSJezutwLk89\",\n \"campaignId\": \"Loju7pdlsu5n6clieofye6b8unxeHy7\",\n \"purchaseAmount\": 100,\n \"donatorEmail\": \"example@email.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.goodify.com/api/v2/donations/purchase"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Methods","value":"GET,HEAD,PUT,PATCH,POST"},{"key":"Access-Control-Expose-Headers","value":"Content-Length"},{"key":"Access-Control-Allow-Headers","value":"Accept, Authorization, Content-Type, X-Requested-With, Range"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 18 May 2022 07:56:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bc999a51-9a56-4e23-b540-ca77f0a73825"}],"event":[{"listen":"prerequest","script":{"id":"822fee76-54ad-43cb-805f-03c4b5c66659","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7334f5ff-07bb-47d6-acad-0e5c59e57975","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.goodify.com"}]}